Resource OperationDefinition/FHIR Server from package hl7.fhir.us.ndh#current (47 ms)

Resources that use this resource

CapabilityStatement
national-directory-api-base-expanded-server	National Directory API Base Expanded Server Capability Statement
national-directory-api-base-server	National Directory API Base Server Capability Statement
national-directory-api-server	National Directory API Capability Statement

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "ndhschexport",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ndhschexport</b></p><a name=\"ndhschexport\"> </a><a name=\"hcndhschexport\"> </a><a name=\"ndhschexport-en-US\"> </a><p>URL: [base]/$ndhschExport</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>_account</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>This parameter is used to specify the user account. Will be used for cancel the request in the future;\nquery the status of the request; and query the result of the request.</p>\n</div></td></tr><tr><td>IN</td><td>_scheduledId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#id\">id</a></td><td/><td><div><p>This parameter is used to specify the request identifier. Will be used for cancel the request in the future;\nquery the status of the request; and query the result of the request.</p>\n</div></td></tr><tr><td>IN</td><td>_type</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A string of comma-delimited following resource types: CareTeam,Endpoint, HealthcareService, InsurancePlan, Location, Network,\nOrganization, OrganizationAffiliation, Practitioner, PractitionerRole, and Verification.<br/>\nThe response SHALL be filtered to only include resources of the specified resource types(s).<br/>\nIf this parameter is omitted, the NDH server SHALL return all supported resources within the scope of the client authorization</p>\n</div></td></tr><tr><td>IN</td><td>_typeFilter</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>string of comman-delimited FHIR REST search queries.<br/>\nWhen provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only\ninclude resources that meet the specified criteria</p>\n</div></td></tr><tr><td>IN</td><td>_outputFormat</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The format for the requested ndhschexport data file to be generated default to application/fhir+ndjson. The NDH server MAY\nsupport additional formats, such as application/csv</p>\n</div></td></tr><tr><td>IN</td><td>_startdate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>This parameter is used to specify the start dateTime of the export.</p>\n</div></td></tr><tr><td>IN</td><td>_frequency</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Duration\">Duration</a></td><td/><td><div><p>For Natioonal Directory API, only the following unit will be used d-day  wk-week, mo-month, a-year.</p>\n</div></td></tr><tr><td>IN</td><td>_cancel</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>If you want to cancel the operation, set the value to true.</p>\n</div></td></tr><tr><td>IN</td><td>_keepFile</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#boolean\">boolean</a></td><td/><td><div><p>This parameter is used to specify whether to keep the file on the server after the file is downloaded.\nif the value is absent the server will keep the file on the server.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pa"
    }
  ],
  "url" : "http://hl7.org/fhir/us/ndh/OperationDefinition/ndhschexport",
  "version" : "1.0.0-ballot",
  "name" : "NdhSchExport",
  "title" : "Scheduled NDH Export Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2023-05-25",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [
    {
      "name" : "HL7 International / Patient Administration",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pafm"
        },
        {
          "system" : "email",
          "value" : "pafm@lists.hl7.org"
        }
      ]
    }
  ],
  "description" : "Scheduled NDH Export Operation",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US",
          "display" : "United States of America"
        }
      ]
    }
  ],
  "code" : "ndhschExport",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "_account",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "This parameter is used to specify the user account. Will be used for cancel the request in the future; \nquery the status of the request; and query the result of the request.",
      "type" : "string"
    },
    {
      "name" : "_scheduledId",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "This parameter is used to specify the request identifier. Will be used for cancel the request in the future; \nquery the status of the request; and query the result of the request.",
      "type" : "id"
    },
    {
      "name" : "_type",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "A string of comma-delimited following resource types: CareTeam,Endpoint, HealthcareService, InsurancePlan, Location, Network,\nOrganization, OrganizationAffiliation, Practitioner, PractitionerRole, and Verification.  \nThe response SHALL be filtered to only include resources of the specified resource types(s).  \nIf this parameter is omitted, the NDH server SHALL return all supported resources within the scope of the client authorization",
      "type" : "string"
    },
    {
      "name" : "_typeFilter",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "string of comman-delimited FHIR REST search queries.  \nWhen provided, a server with support for the parameter and requested search queries SHALL filter the data in the response to only \ninclude resources that meet the specified criteria",
      "type" : "string"
    },
    {
      "name" : "_outputFormat",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The format for the requested ndhschexport data file to be generated default to application/fhir+ndjson. The NDH server MAY\nsupport additional formats, such as application/csv",
      "type" : "string"
    },
    {
      "name" : "_startdate",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "This parameter is used to specify the start dateTime of the export.",
      "type" : "dateTime"
    },
    {
      "name" : "_frequency",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "For Natioonal Directory API, only the following unit will be used d-day  wk-week, mo-month, a-year.",
      "type" : "Duration"
    },
    {
      "name" : "_cancel",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If you want to cancel the operation, set the value to true.",
      "type" : "boolean"
    },
    {
      "name" : "_keepFile",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "This parameter is used to specify whether to keep the file on the server after the file is downloaded.\nif the value is absent the server will keep the file on the server.",
      "type" : "boolean"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.